<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LearningFactorFunctionFactory (Apache Commons Math 3.6.1 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="LearningFactorFunctionFactory (Apache Commons Math 3.6.1 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LearningFactorFunctionFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/NeighbourhoodSizeFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunctionFactory.html" target="_top">Frames</a></li>
<li><a href="LearningFactorFunctionFactory.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.math3.ml.neuralnet.sofm</div>
<h2 title="Class LearningFactorFunctionFactory" class="title">Class LearningFactorFunctionFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.math3.ml.neuralnet.sofm.LearningFactorFunctionFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">LearningFactorFunctionFactory</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Factory for creating instances of <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><code>LearningFactorFunction</code></a>.</div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>3.3</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm">LearningFactorFunction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunctionFactory.html#exponentialDecay(double,%20double,%20long)">exponentialDecay</a></strong>(double&nbsp;initValue,
                double&nbsp;valueAtNumCall,
                long&nbsp;numCall)</code>
<div class="block">Creates an exponential decay <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><code>function</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm">LearningFactorFunction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunctionFactory.html#quasiSigmoidDecay(double,%20double,%20long)">quasiSigmoidDecay</a></strong>(double&nbsp;initValue,
                 double&nbsp;slope,
                 long&nbsp;numCall)</code>
<div class="block">Creates an sigmoid-like <code>LearningFactorFunction function</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="exponentialDecay(double, double, long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exponentialDecay</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm">LearningFactorFunction</a>&nbsp;exponentialDecay(double&nbsp;initValue,
                                      double&nbsp;valueAtNumCall,
                                      long&nbsp;numCall)</pre>
<div class="block">Creates an exponential decay <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><code>function</code></a>.
 It will compute <code>a e<sup>-x / b</sup></code>,
 where <code>x</code> is the (integer) independent variable and
 <ul>
  <li><code>a = initValue</code>
  <li><code>b = -numCall / ln(valueAtNumCall / initValue)</code>
 </ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initValue</code> - Initial value, i.e.
 <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html#value(long)"><code>value(0)</code></a>.</dd><dd><code>valueAtNumCall</code> - Value of the function at <code>numCall</code>.</dd><dd><code>numCall</code> - Argument for which the function returns
 <code>valueAtNumCall</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the learning factor function.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if <code>initValue &lt;= 0</code> or <code>initValue &gt; 1</code>.</dd>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>valueAtNumCall &lt;= 0</code>.</dd>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>valueAtNumCall &gt;= initValue</code>.</dd>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>numCall &lt;= 0</code>.</dd></dl>
</li>
</ul>
<a name="quasiSigmoidDecay(double, double, long)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>quasiSigmoidDecay</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm">LearningFactorFunction</a>&nbsp;quasiSigmoidDecay(double&nbsp;initValue,
                                       double&nbsp;slope,
                                       long&nbsp;numCall)</pre>
<div class="block">Creates an sigmoid-like <code>LearningFactorFunction function</code>.
 The function <code>f</code> will have the following properties:
 <ul>
  <li><code>f(0) = initValue</code></li>
  <li><code>numCall</code> is the inflexion point</li>
  <li><code>slope = f'(numCall)</code></li>
 </ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initValue</code> - Initial value, i.e.
 <a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html#value(long)"><code>value(0)</code></a>.</dd><dd><code>slope</code> - Value of the function derivative at <code>numCall</code>.</dd><dd><code>numCall</code> - Inflexion point.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the learning factor function.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if <code>initValue &lt;= 0</code> or <code>initValue &gt; 1</code>.</dd>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>slope &gt;= 0</code>.</dd>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>numCall &lt;= 0</code>.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LearningFactorFunctionFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/commons/math3/ml/neuralnet/sofm/NeighbourhoodSizeFunction.html" title="interface in org.apache.commons.math3.ml.neuralnet.sofm"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/commons/math3/ml/neuralnet/sofm/LearningFactorFunctionFactory.html" target="_top">Frames</a></li>
<li><a href="LearningFactorFunctionFactory.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2003&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
